home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Applications 1999 May / SGI IRIX 6.5 Applications 1999 May.iso / dist / insight.idb / usr / share / catman / u_man / cat1 / mkhelp.z / mkhelp
Text File  |  1998-05-04  |  9KB  |  199 lines
  1.  
  2.  
  3.  
  4. MMMMkkkkhhhheeeellllpppp((((1111))))                                                            MMMMkkkkhhhheeeellllpppp((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      mkhelp - make a help book
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      mmmmkkkkhhhheeeellllpppp [-fa] [-fi] [-si] [-nl] [-pub] [-comp] [-bkdb book_database] [-sl
  13.      stop_list] [-output out_directory] book_name
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      MMMMkkkkhhhheeeellllpppp makes a help book given the name of the book to make.  Although
  17.      mmmmkkkkhhhheeeellllpppp will run over a networked file system (such as NFS), we highly
  18.      recommend that this program be run on the file server where the book is
  19.      found.  Performance can be up to 10 times better when run locally.
  20.      MMMMkkkkhhhheeeellllpppp first looks to see if the book database (given either in the
  21.      .ebtrc file or on the command line) exists.  If it does not exist, it is
  22.      created and initialized.  Thus, to create a new book database, mmmmkkkkhhhheeeellllpppp
  23.      should simply be run with either no parameters, or just the -bkdb
  24.      parameter.  If a valid book database already exists, mmmmkkkkhhhheeeellllpppp looks for a
  25.      directory in the book database directory named _b_o_o_k_s . Within this
  26.      directory, mmmmkkkkhhhheeeellllpppp looks for a directory named _b_o_o_k__n_a_m_e, where book_name
  27.      is given on the command line.  Within this directory, mmmmkkkkhhhheeeellllpppp looks for a
  28.      file named _b_o_o_k__n_a_m_e._s_g_m . Within the book directory, there should also
  29.      be a directory called _s_t_y_l_e_s, containing the ascii style sheets for the
  30.      book.  Often, this directory is a symbolic link to a directory containing
  31.      the stylesheets for a given DTD.
  32.  
  33.      MMMMkkkkhhhheeeellllpppp works in three stages.  First, the sgml file is compiled into a
  34.      database directory, producing the directory _e_b_t . Second, any toc
  35.      stylesheets are used to build table of contents directories which are
  36.      also stored in the _e_b_t directory .  Finally, the index for the book is
  37.      created, and stored in the index database.
  38.  
  39.      Once mmmmkkkkhhhheeeellllpppp has run, you can remove the .sgml file from the book
  40.      directory (still save it somewhere for later revisions), since the
  41.      resulting files contain all of the information needed to display an sgml
  42.      document.
  43.  
  44. CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNNSSSS
  45.      MMMMkkkkhhhheeeellllpppp uses the .ebtrc file to find configurations.  The .ebtrc file is
  46.      found by the following method.  EBTRC should be set to
  47.      /usr/share/Insight/system.insightrc.  If the EBTRC environment variable
  48.      is set, its values is taken to be the path of the .ebtrc file.  If not,
  49.      the current directory is searched for a .ebtrc file.  Finally, the user's
  50.      home directory is searched for the .ebtrc file.  The following
  51.      configurations are used by MMMMkkkkhhhheeeellllpppp....
  52.  
  53.      BOOK_DBASE, if set, is used as the database directory for books.  The
  54.      -bkdb command line option overrides this setting.
  55.  
  56.      DATA_DIR is used to find EBT general data, such as the help document.
  57.      This should be set to the EBT data directory which is
  58.      /usr/share/Insight/lib/data.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MMMMkkkkhhhheeeellllpppp((((1111))))                                                            MMMMkkkkhhhheeeellllpppp((((1111))))
  71.  
  72.  
  73.  
  74. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  75.      ----ffffaaaa       force all operation involved in the making of the book.  All
  76.                stages of the book are made regardless of when they were last
  77.                made and if they are up to date.  This option should be used
  78.                when making books with a newly released version of mmmmkkkkhhhheeeellllpppp....
  79.  
  80.      ----ffffiiii       forces just the making of the full text index.  The index is
  81.                remade regardless of when it was last made and if it is out of
  82.                date or not.
  83.  
  84.      ----ssssiiii       suppresses the making of the full text index.  The index is not
  85.                made, regardless of when it was last made, or if it was last
  86.                made.
  87.  
  88.      ----nnnnllll       sets no locking mode to on.  In this case, books will not be
  89.                locked.  You are on your own to make sure that two users don't
  90.                make the same book at the same time.  Use this when the network
  91.                will not allow locks to work correctly.
  92.  
  93.      ----mmmmeeeemmmm ssssiiiizzzzeeee sets the amount of memory mmmmkkkkhhhheeeellllpppp will use to ssssiiiizzzzeeee megabytes.
  94.                The more memory used, the fewer flush files are created.  By
  95.                default, mmmmkkkkhhhheeeellllpppp uses only 4 MB on UNIX systems.
  96.  
  97.      ----ppppuuuubbbb      sets publishing to on.  In this mode, mmmmkkkkhhhheeeellllpppp will create a book
  98.                which is certified for publication for use with a stand-alone
  99.                browser.  It will print a message giving you the serial number
  100.                which you should use to allow browsers to read this book.
  101.  
  102.      ----ccccoooommmmpppp     sets compression on.  In this mode, mmmmkkkkhhhheeeellllpppp will create a book
  103.                which is more compressed than the norm.  This might hurt
  104.                performance.
  105.  
  106.      ----bbbbkkkkddddbbbb bbbbooooooookkkk____ddddaaaattttaaaabbbbaaaasssseeee
  107.                Sets the book database directory to book_database.  This
  108.                overrides the BOOK_DBASE setting in the .ebtrc.
  109.  
  110.      ----ssssllll ssssttttoooopppp____lllliiiisssstttt
  111.                Sets the stop list file for the indexer to stop_list.  The full
  112.                path is DATA_DIR/index/stop_list.stp.  Any words on this list
  113.                are not indexed.
  114.  
  115.      ----oooouuuutttt oooouuuuttttppppuuuutttt____ddddiiiirrrreeeeccccttttoooorrrryyyy
  116.                specifies a directory in which to output sgml data.  This
  117.                directory better not be the book directory, or else you will be
  118.                warned an no directory will be used.  The outputted information
  119.                is an equivalent SGML file(s) containing unique EBTIDs, such
  120.                that link information can be kept valid from revision to
  121.                revision of the document.
  122.  
  123.      bbbbooooooookkkk____nnnnaaaammmmeeee Sets the name of the book to make to book_name.  This option is
  124.                required by
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MMMMkkkkhhhheeeellllpppp((((1111))))                                                            MMMMkkkkhhhheeeellllpppp((((1111))))
  137.  
  138.  
  139.  
  140. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  141.      To make a book in the book database specified in the .ebtrc file, you
  142.      might use this command:
  143.      mkhelp my_book
  144.  
  145.      To make a book in the my_book_database, try this command:
  146.      mkhelp -bkdb my_book_database my_book
  147.  
  148.      To make a book without a full text index, try this command:
  149.      mkhelp -si my_book
  150.  
  151.      To force the making of a book, but to leave out the full text index, try
  152.      this:
  153.      mkhelp -fa -si my_book
  154.  
  155.      To force just the full text indexing of a book, use this command:
  156.      mkhelp -fi my_book
  157.  
  158. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  159.      Along the way, mmmmkkkkhhhheeeellllpppp will try to keep the user informed of its progress.
  160.      In most cases, it will not perform an operation if it can recognize that
  161.      the operation has been performed since the last modification to the
  162.      source file.  Of course, it will notify the user about any operations it
  163.      deems unnecessary to perform.  If mmmmkkkkhhhheeeellllpppp finds an error in the sgml file
  164.      or in a style sheet, it will print a friendly error message and abort.
  165.      In this case, you should contact the person responsible for publishing
  166.      the book.
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.